home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 1 / CU Amiga Magazine CD-ROM Special Edition (1995)(EMAP Images)(GB)[Issue 1995-11].iso / Aminet / biz / dbase / QuickFile.lha / QuickFile / QuickFile.doc < prev    next >
Text File  |  1995-03-09  |  42KB  |  1,183 lines

  1.   Quickfile v3.10 copyright 1992-1995 by Alan Wigginton
  2.  
  3. I accept no liability for any loss or damage resulting from the use of
  4. this program.  Users must evaluate the program and decide its usefulness
  5. for their own purposes.
  6.  
  7. QuickFile is not Public Domain, however it can be freely distributed
  8. provided all documentation and sample files are included unchanged.
  9.  
  10. QuickFile is a flexible, flat file database. It uses random access with
  11. indexing for fast access to records. Files can be larger than available
  12. ram, but as much of the file as possible is kept in ram to reduce disk
  13. accesses. Features include:
  14.  
  15.     - Multiple indexes with unique and non-unique keys
  16.     - Data types include character, date, integer, floating point,
  17.       calculation, cycle, image and external
  18.     - Up to 250 characters per field  and 250 fields per record.
  19.     - Form and list style displays and reports.
  20.     - Unlimited number of views of each file.
  21.     - Sort over any number of keys, ascending and descending order.
  22.     - Search operators include Like, Equal, Between, Sounds Like, Not Like
  23.       and Not Equal.
  24.     - Fields can be added, changed, or deleted at any time.
  25.     - ASCII export/import
  26.     - Multi column label printing.
  27.     - Multi-level grouping and totalling
  28.     - Any number of open windows
  29.     - Online context sensitive AmigaGuide help
  30.  
  31. System Requirements
  32.  
  33.     Any Amiga computer with 1 meg or more RAM. (It may run in 512k)
  34.     Workbench 2.04 or later
  35.     mathieeesingtrans.library
  36.     mathieeedoubbas.library
  37.     mathieeedoubtrans.library
  38.  
  39. QuickFile will work with XFH-handler (a file compression program) but
  40. XFH-handler requires that the decompressed file fit completely in ram.
  41. To work with QuickFile such programs must support update of an existing
  42. file.
  43.  
  44. QuickFile is written in C using DICE version 3.0.
  45.  
  46. ====== CONDITIONS OF USE =====
  47.  
  48. This version of the program can be used for free on the condition that you
  49. write and let me know that you are using it - a postcard will do.
  50.  
  51. Donations of money, stamps, software etc will be gratefully accepted. If
  52. you would like to register for updates, bug fixes and support, please send
  53. at least $20.00 to the address below. Overseas users please use
  54. international money order or bank draft - not personal cheques. Any cash
  55. currency is OK, but you send it at your own risk.
  56.  
  57.       Alan Wigginton
  58.       23 Carissa St
  59.       Shailer Park, Queensland  4128.
  60.       AUSTRALIA
  61.  
  62. Registration will get you the latest version of the program and prompt
  63. attention by mail to any problems you may encounter. You will also be
  64. advised when major upgrades are available.
  65.  
  66. The next upgrade will probably again be shareware with an annoying
  67. requester in the freely distributable version.
  68.  
  69. I would appreciate any comments or suggestions.
  70.  
  71. WARNING. QuickFile is a random access data base that buffers records in
  72.      memory. Failure to exit the program properly after updates are
  73.      made will result in lost updates.
  74. ALWAYS     exit the program before a reboot or power off.
  75. DO     backup your files regularly.  When backing up a data base make
  76.      sure you backup all of the files - definition, data and indexes.
  77.  
  78. To install QuickFile to a hard disk or floppy, drag the QuickFile icon to
  79. the drawer of your choice. If you want to use the AmigaGuide help system,
  80. copy QuickFile.guide to the same directory. To install AmigaGuide
  81. doubleclick on the InstallAmigaGuide icon.
  82.  
  83. Icons are not generated by the program. Sorry, but if you want them you
  84. will have to create them yourself.
  85.  
  86. ===== Starting QuickFile ======
  87.  
  88. QuickFile may be started from Workbench using either the program icon or a
  89. project icon.
  90.  
  91. It may also be started from the CLI. The program name may be followed by
  92. a file name.
  93.  
  94. QuickFile opens a window on the default public screen. The default window
  95. size is a few pixels smaller than the screen size. Window size and
  96. position are saved when a view is saved.
  97.  
  98. ===== About Views ======
  99.  
  100. Views allow you to display data from a file in different ways. There are
  101. two basic types FORM and LIST.
  102.  
  103. Each view has its own field titles, positions and lengths, window size and
  104. report details. Once you have a view set out the way you want it, you can
  105. save it for future use.
  106.  
  107. The Define View requester is used to select or change the fields included
  108. in a view. The positions of fields on a form can be changed by dragging
  109. them around with the mouse.
  110.  
  111. When you open a file, QuickFile looks for a view called filename.VIEW. To
  112. automatically use your favourite view, save it as filename.VIEW in the
  113. same directory as the data base.
  114.  
  115. If you want to keep things simple and are happy with the default view, you
  116. need not define a view at all.
  117.  
  118. Views are typically used to print labels, export or import selected fields
  119. or print lists containing only selected fields.
  120.  
  121.  
  122. =========== Keyboard ===================
  123.  
  124. The following keys are available when the cursor is not in a string
  125. gadget (Press RETURN or ESC to de-activate a string gadget):
  126.  
  127.    RETURN        Same as OK button
  128.    ESC            Same as CANCEL button
  129.    TAB            Activate first string gadget
  130.    HELP         Displays help. Requires Amigaguide.library in libs: and
  131.             QuickFile.guide in the same drawer as QuickFile.
  132.    Down arrow        Next record
  133.    Up arrow        Previous record
  134.    Shift-down arrow Next page
  135.    Shift-up arrow   Previous page
  136.  
  137. The following keys can be used in string gadgets:
  138.  
  139.    TAB              Move to next field
  140.    Shift-TAB          Move to previous field
  141.    Down arrow          Move to next field
  142.    Up arrow          Move to previous field
  143.    Return          De-activate string gadget if value is valid
  144.    ESC              De-activate string gadget ignoring errors
  145.    right Amiga-X      Erase all text in the gadget (as does Control-X)
  146.    right Amiga-Q      Restores the text that was present before you
  147.               changed it.
  148.    Shift-left arrow   Moves the cursor to the beginning of the field.
  149.    Shift-right arrow  Moves the cursor to the end of the field.
  150.    Shift-Del          Erases all characters from the cursor to the end of
  151.               the gadget.
  152.    Shift-Backspace    Erases all characters to the left of the cursor.
  153.  
  154. ============== MAIN WINDOW =================
  155.  
  156. Windows can be resized using the sizing gadget. The zoom gadget will
  157. iconify the window (reduce to a short title bar).
  158.  
  159. ===== Form Display ======
  160.  
  161. The FORM DISPLAY shows a single record per screen in the format specified
  162. by the current view.
  163.  
  164. Field positions can be changed by dragging fields around the window with
  165. the mouse. Field sizes can be changed by dragging the bottom right corner
  166. of the drag box. Note that although field height can be changed, only
  167. images will use more than a single line.
  168.  
  169. Pressing the "R" button displayed at the start of an external field will
  170. run the command defined for the field, provided the field is not empty.
  171.  
  172. To add or delete fields, change field titles or displayed lengths, press
  173. the VIEW button;
  174.  
  175. ===== List Display ======
  176.  
  177. The LIST display shows as many records as will fit in the window with a
  178. single line per record.
  179.  
  180. To update a record double click on it with the left mouse button
  181.  
  182. Before using the Modify or Delete buttons, select a record using a single
  183. press of the left mouse button.
  184.  
  185. ===== Buttons =====
  186.  
  187. GoTo
  188.   GoTo finds a record by key value using the current index. This makes
  189.   access extremely fast, even on large files.
  190.  
  191.   You only need to enter enough of the key to identify the record you
  192.   want, but you must start at the first key field.
  193.  
  194. Modify
  195.   Allows you to modify the current record. The horizontal scroll gadget
  196.   can be used to scroll the display and access fields that do not fit in
  197.   the window.
  198.  
  199.   For images or external fields, you can enter the file name in the string
  200.   gadget or press the "F" button to get a file requester. Names entered
  201.   into the string gadget are not validated.
  202.  
  203. Insert
  204.   Displays a blank form for you to enter values for a new record.
  205.  
  206.   The Copy button will copy the contents of the previous record. This is
  207.   useful if you are entering records with similar values in some fields of
  208.   each record. Warning - it replaces anything currently on screen.
  209.  
  210.   Press Cancel (or ESC) to return to Browse mode.  NB When Cancel is
  211.   pressed any values displayed on the screen will be lost.  Press OK
  212.   to insert the record, then Cancel.
  213.  
  214. Delete
  215.  
  216.   Deletes the current record. A requester is displayed to confirm.
  217.   Once the record has been deleted you cannot get it back.
  218.  
  219. Form/List
  220.   Toggles the current view between FORM and LIST formats.
  221.  
  222. View
  223.   Pressing the VIEW button displays the Define View requester with the
  224.   current view.
  225.  
  226. Images
  227.   The Images checkbox in the main window toggles image display on and off
  228.   for faster processing.
  229.  
  230.  
  231. ===== Scrolling =====
  232.  
  233.   Scrolling is controlled by two slider type gadgets.
  234.  
  235.   Vertical Slider
  236.     This controls movement through the file and works in the usual way.
  237.     Scrolling may also be done using the up and down arrow keys for a
  238.     single record, or the shifted keys for a full screen.
  239.  
  240.   Horizontal Slider
  241.    If there are more fields than will fit in the current window, this
  242.    can be used to display the next group of fields.
  243.  
  244. ===========PROJECT  MENU ===================
  245.  
  246. OPEN
  247. Opens a new file in a new window.
  248.  
  249. LOAD
  250. Opens a new file, replacing the file in the current window.
  251.  
  252. SAVE
  253. Writes all updated blocks and indexes to disk.
  254.  
  255. CLOSE
  256. Writes all updated records and indexes to disk and closes the file and
  257. window.  Closing the last window will exit the program.
  258.  
  259. SAVE AS
  260. Creates a new file from the current file. Indexes for the new file are not
  261. created - they will be built when you first open the new file.
  262.  
  263. NEW
  264. Opens a new window for you to define a new file.
  265.  
  266. ALTER
  267. Displays the file definition panel for you to alter the current file
  268. definition. Note that the data and any updated views are saved first.
  269.  
  270. EXPORT
  271. Writes all, or selected, records to an ASCII file for exchanging data with
  272. other applications such as word processors, other data bases etc. The
  273. order and length of the fields in the export file is determined by the
  274. current view. Before doing the export, you may need to create a new view
  275. to give the record layout you want. See export section for details.
  276.  
  277. IMPORT
  278. Loads records from an ASCII file into your data base. The sequence and
  279. length of fields in the input file are determined from the current view.
  280. You should create and select the view before selecting the import
  281. function. See Import section for details.
  282.  
  283. REORGANISE
  284. Reorganises a file by creating a new optimised version and then copying
  285. that version over the main file.
  286.  
  287. Reorganising is not essential, but if you have been doing many additions
  288. and deletions, it may reduce file size and will improve performance.
  289.  
  290. During reorganisation free space is adjusted to the value specified in
  291. the file definition and records are physically stored in the sequence of
  292. the active key. Select your most used key sequence before reorganising to
  293. optimise access with that key.
  294.  
  295. ========= VIEW MENU ==========
  296.  
  297. VIEWS
  298. Displays a requester showing a list of currently loaded views for you to
  299. choose from. If you have not created or loaded any views, you will have a
  300. single view called filename.VIEW.
  301.  
  302. Press the Close button to drop the selected view. You cannot close all
  303. views - you must have at least one loaded.
  304.  
  305. NEW
  306. Creates a new view called 'unnamed' and displays it in the define View
  307. requester.
  308.  
  309. LOAD
  310. Loads another view from disk which becomes the current view.
  311.  
  312. If fields in the view cannot be located in the file definition, they will
  313. be dropped, and a requester displayed to warn you. This will happen if you
  314. delete fields from the file or change field names in the file definition.
  315.  
  316. SAVE
  317. Saves changes made to an existing view. If the view has been newly created
  318. a file requester will be displayed to confirm the name.
  319.  
  320. SAVE AS
  321. Saves the current view under a new name. A view can have any name but the
  322. .view suffix should be used for easy identification.
  323.  
  324. RESET FORM
  325. Resets field positioning back to the default.
  326.  
  327. ========== ORDER MENU =========
  328.  
  329. INDEXES
  330. Displays a list of indexes. Choose an index fromt the list to change the
  331. display sequence. If you have performed a sort or selection, the list will
  332. include "Selected" and/or "Sorted".
  333.  
  334. Pressing the Close Button will remove a "Sort" or "Selection" from memory
  335. and free the space used. To remove any permanent index use the
  336. Project/Alter menu item to alter the file definition.
  337.  
  338. SORT
  339. Displays the sort requester to sort into a new sequence
  340.  
  341. SHOW SORTED
  342. Uses last sort for the display sequence.
  343.  
  344. REBUILD INDEX
  345. Rebuilds the current index from the data file.
  346.  
  347. This can be used if the index and data files are inconsistent for some
  348. reason (eg a system failure). The index is rebuilt from the data file.
  349.  
  350. Try using this if the program is failing with a 'Block not found message'
  351. or any messages to the effect that QuickFile could not find a record it
  352. looked for.
  353.  
  354. ======= SELECTION MENU ===========
  355.  
  356. SELECT
  357. Searches for records matching your selection criteria. See later for full
  358. details.
  359.  
  360. SHOW SELECTED
  361. Displays current selection
  362.  
  363. SHOW ALL
  364. Displays all records. The current selection is retained.
  365.  
  366. ======= PRINT MENU ===============
  367.  
  368. DISPLAYED RECORDS
  369. Prints the records currently displayed on the screen. This will be a
  370. single record for a form display.
  371.  
  372. ALL RECORDS IN CURRENT INDEX
  373. Prints all records in the current index (or Sort or Selection).
  374.  
  375. The fields printed and the style (form or list) of report is determined by
  376. the current view.
  377.  
  378. See Print Requester for full details
  379.  
  380. =============== OPTIONS MENU ====================
  381.  
  382. ABOUT
  383. Too obvious to explain
  384.  
  385. BUFFERS
  386. Displays number  of blocks in the file and the maximum and in-use number
  387. of RAM buffers. You can change the maximum number of ram buffers. To
  388. permanently change the maximum number of buffers, use the Project/Alter
  389. menu item to change the file definition.
  390.  
  391. ============ DEFINE VIEW REQUESTER =================
  392.  
  393. Name
  394.   Identifies the view. This can be changed for a new view, but is display
  395.   only for an existing view.
  396.  
  397. Available Fields List
  398.   Lists the fields in the current file. Clicking on a field will add it to
  399.   the current view.
  400.  
  401. View Fields List
  402.   Lists the fields in the current view. Clicking on a field in this list
  403.   will select it and display its title and length below the list box.
  404.   These can then be changed if required. The changes will only affect the
  405.   current view.
  406.  
  407.   New fields will be added before the current selected field. To add
  408.   fields to the end of the list, select the "== End ==" item.
  409.  
  410. Type Buttons
  411.   Choose type of view - FORM or LIST.
  412.  
  413. Headings Check Box
  414.   Field names are displayed if this is checked. This is normally only
  415.   turned off for printing labels.
  416.  
  417. Field Title String Gadget
  418.   This is the text gadget under the View Fields list. You can change the
  419.   field title for this view only. For example you may want a short title
  420.   for a short field on the list display but use the full name for the form
  421.   display. The title can be blank. This gadget is disabled unless one of
  422.   the View Fields is selected.
  423.  
  424. Length String Gadget
  425.   Use this to reduce or increase the field display length for this view
  426.   only.
  427.  
  428. IMPORTANT NOTE: You must press enter after changing either the field name
  429.   or length or your changes will be ignored.
  430.  
  431. Clear Button
  432.   Deletes all fields from the View Fields list.
  433.  
  434. Delete Button
  435.   Deletes the selected field from the View Fields list.
  436.  
  437. =================== SORT REQUESTER ==================
  438.  
  439. Sort creates a temporary index which is discarded when the file
  440. is closed. The sort sequence will be maintained as you add or delete
  441. records.
  442.  
  443. The sort technique used requires that all sort keys be resident in memory,
  444. so record buffers are freed to increase the memory available to the sort.
  445. If you are short of memory, it may help to sort using less than the full
  446. length of long fields.
  447.  
  448. Available Fields
  449.   Lists the fields defined in this file. Clicking on a field will add it
  450.   to the Sort Fields.
  451.  
  452. Index Fields
  453.   Lists the fields to be used for the sort. The order of the fields
  454.   in this box determines their priority in the sort. The first field is
  455.   the primary key, the second will only be used for records where the
  456.   first keys are equal and so on.
  457.  
  458.   Clicking on a field in this list will select it and display its name
  459.   and length below the list box.
  460.  
  461.   New fields are inserted before the currently selected field. To add a
  462.   field to the end of the list, select the "== End ==" entry.
  463.  
  464. Length
  465.   Changing this length allows you to sort over part of a long field, to
  466.   save memory and speed sorting
  467.  
  468.   IMPORTANT: YOU MUST PRESS ENTER OR RETURN AFTER CHANGING A LENGTH OR
  469.          YOUR CHANGES WILL BE IGNORED
  470.  
  471. Order
  472.   Select A..Z for ascending sequence or Z..A for descending. You can mix
  473.   these on different fields in the same index.
  474.  
  475. Clear Button
  476.   Deletes all fields from the Index Field List
  477.  
  478. Delete
  479.   Deletes the selected field from the Index Fields list.
  480.  
  481. ==================== SELECTION ====================
  482.  
  483. A selection is a sub-set of the data base that matches specified
  484. conditions. QuickFile searches through the whole data base looking for
  485. records with fields matching requested values, and creates an index
  486. containing these records. You can then browse, print, export or create a
  487. new database with the selected records.
  488.  
  489. The selection is updated automatically for deletions and changes but not
  490. additions.
  491.  
  492. When displaying a selection, the title bar will show the number of records
  493. in the selection.
  494.  
  495. The selected data will be in the same sequence as the current Index.  You
  496. can sort it into another sequence if required.    If the current index is
  497. the result of a previous selection, only the selected records are
  498. searched.
  499.  
  500. You can use any number of criteria for a search, but the more you have the
  501. slower the search will be.
  502.  
  503. ============== Search Panel =================
  504.  
  505. The Search Panel displays a list of search criteria with buttons for
  506. inserting, modifying and deleting them.
  507.  
  508. Two values can be specified for each item. The second value is primarily
  509. for the Between operator, but it can be used to specify an alternative
  510. value for the other operators.
  511.  
  512. Clicking on the Insert or Modify displays the Search Details requeste for
  513. you to insert or modify the details.
  514.  
  515. For insertions, the new item will be inserted before the selected item. To
  516. insert a new item at the end of the list, select the "== End ==" item.
  517.  
  518. Clicking on delete will bring up a requester for you to confirm the
  519. deletion of the selected item.
  520.  
  521. Search criteria linked with 'and' will select only records that match both
  522. criteria, while search criteria linked with 'or' will select records that
  523. match either criteria.
  524.  
  525. 'And' has higher precedence so criteria are formed into groups split by
  526. 'or'. All criteria in a group must be satisfied for a record to be
  527. selected, but a record will be selected if it matches any group. That is
  528. confusing and is probably best explained with an example:
  529.  
  530.       Occupation equal     programmer
  531.   and location     equal     sydney
  532.   or  Occupation equal     programmer
  533.   and location     equal     canberra
  534.  
  535. This will find all programmers who live in Sydney or Canberra. Note that
  536. Occupation had to be repeated. The following would give all programmers
  537. who live in Sydney and EVERBODY who lives in Canberra.
  538.  
  539.       Occupation equal     programmer
  540.   and location     equal     sydney
  541.   or  location     equal     canberra
  542.  
  543. You can also do things like
  544.  
  545.        Name     like     john
  546.   and  Name     notlike smith
  547.  
  548. which would find all persons named John, except those named John Smith.
  549.  
  550. ========= Search Details ======================
  551.  
  552. And, Or Buttons
  553.   Choose AND or OR to specify how this search item is combined with the
  554.   previous one. It has no effect for the first item.
  555.  
  556. Available Fields List
  557.   Lists all the fields in the file defintion. The current selection is
  558.   displayed under the list.
  559.  
  560. Comparison Operator (like, equal etc)
  561.   Choose the operator to be used for this search item. (see below)
  562.  
  563. Value 1
  564.   The primary search value. It is always used. If you want to search for
  565.   empty fields leave this empty.
  566.  
  567. Value 2
  568.   This is the secondary search value. Its primary use is with the between
  569.   operator but can be used to enter an second search value for the other
  570.   operators.
  571.  
  572.   Note that with Not Equal and Not Like, value 1 and value 2 are joined by
  573.   AND rather than OR. It will find all records except those that contain
  574.   value 1 or value 2. Using OR in this situation would select every
  575.   record.
  576.  
  577. ======= Search Operators ===============
  578.  
  579. Like
  580.   Matches fields that contain the search string anywhere within them. eg
  581.   "bit" would find "The Hobbit" and "Bitter Sweet".
  582.  
  583. Equal
  584.   Matches a field only if it exactly equals the search value. Case is not
  585.   significant so that dog will match Dog or even dOG.
  586.  
  587. Between
  588.   Matches a field with a value equal to or between the specified pair of
  589.   values. This can also be used to perform a less than or greater than
  590.   search. e.g. 'between 41 and 999' is the same as 'greater than  40'.
  591.  
  592. Sounds Like
  593.   Matches fields where the first word sounds like the search value. This
  594.   is really a bit of a gimmick as it is not very smart. NOTE it only looks
  595.   at the first word of the field.
  596.  
  597. Not Like
  598.   As for like but only matches records that do not contain the search
  599.   value.
  600.  
  601. Not Equal
  602.   As for equal but only matches records that do not match the search
  603.   value.
  604.  
  605. ====== EXPORT REQUESTER ======
  606.  
  607. A number of preset formats are provided or you can tailor your own record
  608. and field Separators by selecting the Custom format.
  609.  
  610. The headers button determines whether a header record containing the field
  611. names is to be included at the start of the file.
  612.  
  613. Pressing the OK Button displays a file requester for you to specify the
  614. name of the export file.
  615.  
  616. All records from the current index will be written. If you are displaying
  617. Selected records, only the selected records will be written.
  618.  
  619. ====== IMPORT REQUESTER ======
  620.  
  621. One preset format("...",) is provided or you can tailor your own by
  622. selecting Custom and choosing the Record and Field separators.
  623.  
  624. Both sequence and length can be different from that in the database. Also,
  625. not all database fields need to be present in the ASCII file. Any fields
  626. not present will be set to blank in your data base.
  627.  
  628. NB: It is vital that the sequence and number of fields you set in the
  629. selected fields box of the field selector correspond to the sequence of
  630. fields in the ASCII file you are importing.
  631.  
  632. Make you sure to backup your database before you import a file into an
  633. existing data base. If you get the format wrong, it is easier to restore
  634. than to fix or delete all of the incorrect records.
  635.  
  636. Also use plenty of buffers if you are going to import a large number of
  637. records.
  638.  
  639. ============ Preset Export/Import Formats =================
  640.  
  641. A number of preset formats are provided including the mailmerge formats for
  642. some wordprocessors:
  643.  
  644.  Custom
  645.    Allows you to define your own format using predefined Separator
  646.    characters.
  647.  
  648.  "...",
  649.    This is a quote and comma delimited text file such as used for data for
  650.    BASIC programs.
  651.  
  652. The following preset formats are available only for Export, not Import.
  653.  
  654.     Final Copy
  655.     Interword
  656.     KindWords 3
  657.     ProWrite
  658.     WordWorth
  659.  
  660. Only the KindWords 3 and Interword versions have been tested.
  661.  
  662. ====== Field and Record Separators ========
  663.  
  664. You can only select from the predefined delimiter codes.
  665.  
  666.   Field Start
  667.   The character that marks the start of a field.
  668.  
  669.   Field End
  670.   Marks the end of a field. It differs from the field separator in that a
  671.   separator does not appear after the last field in a record while a field
  672.   end character appears after every field.
  673.  
  674.   Field Separator
  675.   Separates fields in the record. It does not appear after the last field
  676.   in the record
  677.  
  678.   Record End
  679.   Marks the end of a record
  680.  
  681. If Field Start is used, a Field End must also be used. If neither Field End
  682. nor Field Separator is used, the records will be fixed length with each
  683. field padded to its maximum length with spaces.
  684.  
  685.  
  686. ============= PRINT REQUESTER =====================
  687.  
  688. Title
  689.   This is printed, centered, at the top of each page of your report.
  690.   Current date is printed at the left margin and the page number at the
  691.   right margin.
  692.  
  693.   The title line is only printed if you enter a Title. Note that even a
  694.   single space will print a blank title.
  695.  
  696. Left and Right Margins
  697.   Character position of left and right margin.
  698.  
  699. Lines/Page
  700.   This controls the number of lines QuickFile will use on each page. The
  701.   default is paper size minus 8 to provide a top and bottom margin.
  702.  
  703.   NB QuickFile issues a Form Feed when a new page is required. This
  704.   relies on your setting the page height on your printer correctly, and
  705.   may be a limitation with some printers. If you have a problem with this,
  706.   let me know and I will look at using the preferences paper size.
  707.  
  708.   A value of zero will suppress the report title and page breaks.
  709.  
  710. Print Pitch  Cycle Gadget.
  711.   As for Workbench printer preferences
  712.  
  713. Lines Per Inch Cycle Gadget
  714.   This button toggles between 6 and 8 lines per inch.
  715.  
  716. Output To   Cycle Gadget
  717.   Allows you to send the report to the printer or the window.
  718.  
  719. If you are printing a FORM view, a number of additional fields are
  720. displayed for multi-column printing such as address labels. See Labels for
  721. full details.
  722.  
  723. If you are printing a LIST view, a Group By list is displayed. This lists
  724. the report groups defined for this report. See Report Groups.
  725.  
  726. Press the OK button to start printing or the cancel button to cancel any
  727. changes you have entered.
  728.  
  729. Saving the view will save all of your report settings.
  730.  
  731. ========= Labels ============
  732.  
  733. Label printing is available for FORM type views only. You will normally
  734. define a special view and:
  735.  
  736.    Set Field Labels for the view to No
  737.  
  738.    Arrange the fields in the top left hand corner of the FORM screen to
  739.    match the desired label format
  740.  
  741.    Use the following fields in the print requester to control your label
  742.    format.
  743.  
  744. Labels Across
  745.   Number of labels to print across the page
  746.  
  747. Label Width
  748.   Width of each label. One additional space will be allowed
  749.   between labels. If you want to print labels further apart, increase this
  750.   value.
  751.  
  752. Labels Down
  753.   Number of labels to print down the page before starting a new column.
  754.   For example 3 across and 4 down will print in the following sequence:
  755.  
  756.       1      5      9
  757.       2      6     10
  758.       3      7     11
  759.       4      8     12
  760.  
  761. Label Height
  762.   Height of each label in lines. An additional blank line will be printed
  763.   between each label. The default is the number of lines in the form.
  764.  
  765. You will probably want to set Lines Per Page to zero to suppress page
  766. breaks as well.
  767.  
  768. If you are printing a single column of labels only, you can leave all of
  769. the above fields blank and let the number of lines in the form determine
  770. the label height.
  771.  
  772. ======== Report Groups ===================
  773.  
  774. You may know report groups as control breaks. A "group by" field is only
  775. printed when its value changes. You can also calculate summary values for
  776. each group. Each group can be based on several fields, although usually
  777. only one is used. Any number of fields may be summarised for a group.
  778.  
  779. Note that records must be sorted into the correct sequence for this to
  780. work correctly. They are not sorted automatically.
  781.  
  782. The types of groups available are
  783.  
  784. Report.  Gives a summary value for the whole report. If used, it must
  785.      be the first group in the list.
  786. Page.     Groups will start on a new page. Group fields will print
  787.      before column headings.
  788. Subtitle Prints the group fields on a separate line at the start of each
  789.      group. Reduces line length but best when each group contains
  790.      a good number of records.
  791. Normal     Field prints in the first line of the group only, but space
  792.      is used in each line.
  793.  
  794. You can have several levels of groups of the same type, but they must be
  795. listed from highest level to lowest.
  796.  
  797. ============= Report Group Example ============
  798.  
  799. The following example shows two groups with totals.
  800.  
  801.    Group 1 : City     Type: Normal   Group Fields: City
  802.                      Summaries:    Value (total)
  803.  
  804.    Group 2 : Salesman Type: Normal   Group Fields: Salesman
  805.                      Summaries:    Value (total)
  806.  
  807.    Resulting report:
  808.  
  809.     City    Salesman    Client             Value
  810.     ----------    -------------    --------------     ---------
  811.     Brisbane    Fred Smith    ABC Company       8000.00
  812.                 XYZ Limited       6400.00
  813.                 Zip Electronics   12000.00
  814.  
  815.     Salesman Tot                  26400.00
  816.  
  817.         John Brown    ZZZ Computers       5000.00
  818.                 GWZ Peripherals    7200.00
  819.  
  820.     Salesman Tot                  12200.00
  821.  
  822.     City Tot                      28600.00
  823.  
  824. Note: The file must be sorted over City and Salesman for this to print
  825. correctly.
  826.  
  827. ========== Report Group Requester ============
  828.  
  829. This defines the type, grouping fields, and summaries for a single report
  830. group.
  831.  
  832. Group string gadget
  833.   Names the group. This name is printed on summary lines.
  834.  
  835. Type
  836.   Type of group
  837.  
  838. View Fields list
  839.   Lists the fields available in the current view. The selected field in
  840.   this list can be added to either the Group Fields or Summaries lists.
  841.  
  842. Group Fields list
  843.   Lists the fields used for gouping. A new group starts when any of these
  844.   fields change. A group field is not required for a Report level group.
  845.  
  846. Summaries list
  847.   Lists the fields to be summarised for this group. Selecting an item from
  848.   this list will update the check boxes to show the summaries requested.
  849.   Use the INS button to add the selected view field to this list.
  850.  
  851. Tot, Cnt, Avg check boxes
  852.   Show the summaries required for the currently selected Summary field.
  853.   Any or all may be checked for one field.
  854.  
  855. OK and Cancel Buttons
  856.   Return to the Print Requester.
  857.  
  858. ============== DEFINING FILES  ===================
  859.  
  860. Use the Project/New menu item to define a new file.
  861.  
  862. Use the Project/Alter menu item to change the definition for the current
  863. file.
  864.  
  865. You can change just about everything in a file definition, except the
  866. block size, even after you have loaded data to the file. You can change
  867. field names, types and lengths. You can add or delete fields, and add or
  868. delete indexes. Caution should be used when changing the type for fields
  869. that contain data.
  870.  
  871. WARNING: Deleting a field makes its data inaccessible, even if you
  872.        re-add the same field. If you accidentally delete a field, reload
  873.        the definition without saving your changes and start your changes
  874.        again.
  875.  
  876. The fields defined for this file are listed in the box at the right of the
  877. window. Use the buttons beside the window to add, change or delete fields.
  878.  
  879. If a field is highlighted when you press add, the new field will be added
  880. before the selected field. To add a field to the end of the list, select
  881. the "== End ==" item.
  882.  
  883. The indexes (indices?) are listed in the box at the lower left. Use the
  884. buttons to add, change or delete indexes.
  885.  
  886. ================ File Details =================
  887.  
  888. The file details are shown at the top left of the QFDefine window
  889.  
  890. Block Size
  891.   QuickFile does not read and write single records at a time, but builds
  892.   them into blocks. This reduces the number of disk reads and writes
  893.   required. Around 2000 seems to give good results. The only way to change
  894.   block size is to export the whole file, define a new data base and use
  895.   import to recreate your file. Block size must be larger than the maximum
  896.   record size plus free space, plus some space for control fields (2 bytes
  897.   per field plus 2 bytes for the record length).
  898.  
  899. Free Space
  900.   The amount of free space to be left in each block to allow for records
  901.   to expand. As QuickFile only stores the actual data entered (not
  902.   trailing blanks), additional space is required if a change makes a field
  903.   longer. 100 seems to work OK. Records are moved to another block if
  904.   necessary, so this is not critical.
  905.  
  906. Buffers
  907.   Maximum number of buffers QuickFile will use for holding blocks of
  908.   records in memory. Unless you have very large files or are short of
  909.   memory, use a large figure such as 100.  QuickFile will never use more
  910.   buffers than are required for the whole file.
  911.  
  912.   The more of the file in memory, the faster QuickFile works. The memory
  913.   used is approximately (number of buffers * buffer size).
  914.  
  915.   WARNING. If you using a compression program like XFH-handler with
  916.   QuickFile, set the number of buffers to 3. XFH will already have the
  917.   decompressed copy of the file in ram.
  918.  
  919.  
  920. Ext. Path
  921.   This is a default path used for images and external files. The file name
  922.   in each record is stored as a name relative to this path, which can
  923.   reduce the number of characters in each record.
  924.  
  925.  
  926. =========== Field Requester ===========
  927.  
  928. Name string gadget
  929.   Enter a name of up to 12 characters for the field.
  930.  
  931. Length
  932.   60 characters is a practical maximum length as no left and right
  933.   scrolling is provided and more characters cannot be displayed.
  934.   The maximum is 250. The minimum length of a date field is 11 characters.
  935.  
  936.   Space is used only for the number of characters entered in each record,
  937.   not for the maximum field length. In fact, if a field is empty it takes
  938.   up no space at all.
  939.  
  940. Decimals
  941.   Number of decimals stored and displayed for the field. Values entered in
  942.   the field will be rounded to this number of decimals.
  943.  
  944. Type  Push buttons
  945.   Choose type of field. See below for the available types
  946.  
  947. Mandatory Check Box
  948.   If checked, the field must have a value in all records. You will not be
  949.   able to add a new record without a value in this field.
  950.  
  951. Justify Right Check Box
  952.   If checked, the field is right justified. Integer, Float, and Caculated
  953.   fields default to right, character and date fields default to left.
  954.  
  955. Expression String Gadget
  956.   Contents depend on field type
  957.  
  958.     Calc:    The expression to calculate the field value
  959.     Cycle:    The list of possible values
  960.     External:    The command string to be run to process the field content.
  961.  
  962.   See field types for more detail.
  963.  
  964. =============== Field Types ===============
  965.  
  966. Character
  967.   General character string.
  968.  
  969. Integer
  970.   Whole number, no decimals.
  971.  
  972. Float.
  973.   Real numbers with decimals.
  974.  
  975. Calculated
  976.   The field value is calculated from other fields, which may themselves be
  977.   calculated fields.
  978.  
  979.   Enter the calculation in the expression string gadget. The expression
  980.   can contain field names, constants, and the add (+), subtract (-),
  981.   multiply (*) and divide (/) operators. Field names containing spaces
  982.   must be enclosed in double quotes ("). Normal precedence rules apply and
  983.   brackets may be used to control sequence. Fields must be defined before
  984.   they can be referenced.
  985.  
  986. Date
  987.   These have a minimum length of 11 characters and are always entered as
  988.   day/month/year.
  989.  
  990.   The separator can be any of /-. or a space. Month can be entered as a
  991.   number or a three character name. Year can be entered as two or four
  992.   digits. If two digits are used, a number greater than 50 is assumed to
  993.   be this century, 50 or less, the next century.
  994.   For example 03/08/93    3-8-93    3.aug.93  03 aug 1993 are all valid
  995.  
  996.   Dates are always displayed in the format 14-Apr-1993.
  997.  
  998. Cycle
  999.   A list of values is associated with a cycle field. The value is
  1000.   maintained using a cycling button instead of a string gadget.
  1001.  
  1002.   Enter the list of values, separated by commas, in the expression string
  1003.   gadget. Any spaces you enter will be included in the value - you
  1004.   probably don't want leading spaces.
  1005.  
  1006.     for example  Blue,Green,Light Blue,Red
  1007.     instead of     Blue, Green, Light Blue, Red
  1008.  
  1009. Image
  1010.   An image that is displayed in the QuickFile window. Only the file name
  1011.   is stored in the database.
  1012.  
  1013. External
  1014.   Holds file names that can be run using an external program. This can be
  1015.   used for images, sounds, text files, animations or whatever. Enter the
  1016.   command template in the expression string gadget with %s to represent the
  1017.   file name. The full path name of the command is required. For example
  1018.  
  1019.     dh0:utilities/display %s
  1020.  
  1021.   At run time %s will be replaced with the contents of the field in the
  1022.   data base record
  1023.  
  1024.  ============== Indexes =============
  1025.  
  1026. You must define at least one index. If you are not sure pick any field
  1027. that will give a useful sequence, such as surname, title etc. Each index
  1028. can use a number of fields to give precise control of sequence.
  1029.  
  1030. You can have any number of indexes but you should limit yourself to those
  1031. you are going to use regularly.
  1032.  
  1033. You can index on any field type including calculated fields. You can also
  1034. define an index as unique to prevent duplicate records being created.
  1035.  
  1036. If you change an index on an existing file, it will be rebuilt when you
  1037. return to the main display panel.
  1038.  
  1039. Select the index from the list and press the appropriate button. The Index
  1040. Requester is used to define or alter an index definition.
  1041.  
  1042. Indexes are maintained automatically as you add, modify and delete records
  1043. on your file so they reduce the need for sorting and resorting.
  1044.  
  1045. ============ Define Index Requester =================
  1046.  
  1047. Name
  1048.   Identifies the index and is also used to form the index file name.
  1049.  
  1050. Unique CheckBox
  1051.   If checked, duplicate index entries will not be allowed.
  1052.  
  1053. Available Fields
  1054.   Lists fields defined in this file. Clicking on a field will add it to
  1055.   the fields selected for this index.
  1056.  
  1057. Index Fields
  1058.   Lists fields in the current index. The order of the fields in this box
  1059.   determines their priority in the sort. The first field is the primary
  1060.   key, the second will only be used for records where the first keys are
  1061.   equal and so on.
  1062.  
  1063.   Clicking on a field in this list will select it and display its name
  1064.   and length below the list box.
  1065.  
  1066.   If a field is highlighted, any new fields will be added before the
  1067.   highlighted field, otherwise new fields will be added at the end. To
  1068.   remove highlighting click in the blank part of the box.
  1069.  
  1070. Length
  1071.   Changing this length allows you to index on part of a long field. This
  1072.   reduces memory usage and may increase speed.
  1073.  
  1074.   IMPORTANT: YOU MUST PRESS ENTER OR RETURN AFTER CHANGING A LENGTH OR
  1075.          YOUR CHANGES WILL BE IGNORED
  1076.  
  1077. Order Buttons
  1078.   Select A..Z for ascending order or Z..A for descending order. You can
  1079.   mix these on different fields in the same index.
  1080.  
  1081. Delete
  1082.   Deletes the highlighted field from the Index Fields list.
  1083.  
  1084. ===== FILE NAMES =============
  1085.  
  1086.    QuickFile uses four types of file distinguished by extension. Changing
  1087.    these with an  editor will probably corrupt the file. YOU HAVE BEEN
  1088.    WARNED.
  1089.  
  1090.    The DEFINITION FILE has no extension. This is the name you enter when
  1091.    specifying a file name for QuickFile.
  1092.  
  1093.    The DATA FILE has an extension of .Data.
  1094.  
  1095.    VIEW files usually have an extension of .View
  1096.  
  1097.    INDEX FILES have an extension of .nameX where 'name' is the name of the
  1098.    index as specified in the file definition.
  1099.  
  1100. ========== POSSIBLE PROBLEMS =================
  1101.  
  1102. INDEX DOESN'T MATCH DATA FILE
  1103.  
  1104. It is possible for an index and data file to get out of synchronisation.
  1105. This can be caused by not closing a file properly, typically because of a
  1106. guru or power loss with a file open.
  1107.  
  1108. If you suspect an index has been corrupted in some way, you can delete the
  1109. index file (called filename.indnameX).  When you next open the file, the
  1110. index will be rebuilt.    This is indicated by a message such as "getblock:
  1111. Block not found" being displayed in the Console window.
  1112.  
  1113. You can also rebuild an index by selecting the Rebuild Index item from
  1114. the QuickFile tools menu.
  1115.  
  1116. SAVING MEMORY
  1117.  
  1118. If you are short of memory, you can reduce memory requirements by not
  1119. using the online help. You can do this by either removing
  1120. AmigaGuide.library from your libs: directory or by moving QuickFile.guide
  1121. to a different directory from the QuickFile program.
  1122.  
  1123. If you are using a compression program such as XFH-handler, reduce the
  1124. number of buffers in the file definition to 3. Otherwise both XFH and
  1125. QuickFile will be holding the file in ram:
  1126.  
  1127. BUGS
  1128.  
  1129. The program has been reasonably tested, but only on my A500. Some bugs
  1130. refuse to show up until you hit exactly the right combination of
  1131. conditions, so please let me know of any problems you find. Known problems
  1132. (limitations really) are:
  1133.  
  1134. - If you drag a field off the bottom of the window, the drag box is drawn
  1135.   over the border but is not erased properly if you release the mouse
  1136.   button.
  1137.  
  1138. - Date and character fields cannot be used in calculations but you can
  1139.   enter them into expressions.
  1140.  
  1141. - Fields are always added to the bottom of a view, even though you can
  1142.   insert them anywhere in the list of fields for the view.
  1143.  
  1144. - A Field is clipped horizontally, but not vertically, if it does not fit
  1145.   completely in the visible window. This causes images to disappear instead
  1146.   of being clipped if you make the window too small.
  1147.  
  1148. - No attempt is made to remap image palettes. You may get odd colours or
  1149.   a block of a single colour.
  1150.  
  1151. If you write to me with a problem you would like fixed, it is much easier
  1152. for me if you send a copy of your database, the version of the program you
  1153. are using, and instructions on how to duplicate the problem.
  1154.  
  1155. ========== Program Limits ==============
  1156.  
  1157. Field Length
  1158.  
  1159.     While up to 250 characters are allowed per field, this is not very
  1160.     useful as each field is limited to one line.
  1161.  
  1162. Number of Records per File
  1163.  
  1164.     The theoretical limit is currently 65,535. In practice it is much
  1165.     lower because of the indexing technique which will run out of either
  1166.     memory or processor speed. Each index requires a contiguous area of
  1167.     RAM 4(n + 200) bytes in size, where n is the number of records in the
  1168.     file. The sort technique also limits the size of the file.    The sort
  1169.     loads all sort keys to ram and also requires 8 bytes per record in one
  1170.     contiguous area.
  1171.  
  1172.     A realistic maximum is probably in the order of 10,000 to 20,000.
  1173.  
  1174. Number of fields per record
  1175.  
  1176.   250. But I got bored at about 60, so you take your chances if you want
  1177.   to try more.
  1178.  
  1179. Number of indexes
  1180.  
  1181.   No limit.
  1182.  
  1183.